home *** CD-ROM | disk | FTP | other *** search
/ SGI Freeware 2002 November / SGI Freeware 2002 November - Disc 1.iso / dist / fw_curl.idb / usr / freeware / catman / p_man / cat3 / curl_easy_getinfo.Z / curl_easy_getinfo
Text File  |  2002-07-08  |  7KB  |  159 lines
  1. curl_easy_init(3)      libcurl Manual    curl_easy_init(3)
  2.  
  3.  
  4.  
  5. NNAAMMEE
  6.        curl_easy_getinfo  -  Extract information from a    curl ses
  7.        sion (added in 7.4)
  8.  
  9. SSYYNNOOPPSSIISS
  10.        ##iinncclluuddee    <<ccuurrll//ccuurrll..hh>>
  11.  
  12.        CCUURRLLccooddee    ccuurrll__eeaassyy__ggeettiinnffoo((CCUURRLL **ccuurrll,, CCUURRLLIINNFFOO iinnffoo,,  ......
  13.        ));;
  14.  
  15. DDEESSCCRRIIPPTTIIOONN
  16.        Request    internal  information  from the    curl session with
  17.        this function.  The third argument MMUUSSTT be a pointer to    a
  18.        long,  a     pointer to a char * or    a pointer to a double (as
  19.        this documentation  describes  further  down).    The  data
  20.        pointed-to will be filled in accordingly    and can    be relied
  21.        upon only if the    function returns CURLE_OK.  This function
  22.        is  intended to get used    *AFTER*    a performed transfer, all
  23.        results from this function are undefined    until the  trans
  24.        fer is completed.
  25.  
  26. AAVVAAIILLAABBLLEE IINNFFOORRMMAATTIIOONN
  27.        These are informations that can be extracted:
  28.  
  29.        CCUURRLLIINNFFOO__EEFFFFEECCTTIIVVEE__UURRLL
  30.            Pass  a    pointer    to a 'char *' to receive the last
  31.            used effective URL.
  32.  
  33.        CCUURRLLIINNFFOO__HHTTTTPP__CCOODDEE
  34.            Pass a pointer to  a  long  to  receive    the  last
  35.            received    HTTP code.
  36.  
  37.        CCUURRLLIINNFFOO__FFIILLEETTIIMMEE
  38.            Pass  a    pointer     to  a long to receive the remote
  39.            time of the retrieved document. If you get -1,  it
  40.            can  be    because     of  many  reasons  (unknown, the
  41.            server hides it or the server doesn't support  the
  42.            command that tells document time    etc) and the time
  43.            of the document is unknown.  Note  that    you  must
  44.            tell the    server to collect this information before
  45.            the transfer is made, by    using  the  CURLOPT_FILE
  46.            TIME option to _c_u_r_l___e_a_s_y___s_e_t_o_p_t_(_3_). (Added in 7.5)
  47.  
  48.        CCUURRLLIINNFFOO__TTOOTTAALL__TTIIMMEE
  49.            Pass a pointer to a double to  receive  the  total
  50.            transaction  time  in  seconds  for  the     previous
  51.            transfer. This time does    not include  the  connect
  52.            time,  so if you    want the complete operation time,
  53.            you should add the CURLINFO_CONNECT_TIME.
  54.  
  55.        CCUURRLLIINNFFOO__NNAAMMEELLOOOOKKUUPP__TTIIMMEE
  56.            Pass a pointer to a double to receive the time, in
  57.            seconds,     it  took  from     the start until the name
  58.            resolving was completed.
  59.  
  60.        CCUURRLLIINNFFOO__CCOONNNNEECCTT__TTIIMMEE
  61.            Pass a pointer to a double to receive the time, in
  62.            seconds,     it took from the start    until the connect
  63.            to the remote host (or proxy) was completed.
  64.  
  65.        CCUURRLLIINNFFOO__PPRREETTRRAANNSSFFEERR__TTIIMMEE
  66.            Pass a pointer to a double to receive the time, in
  67.            seconds,     it  took  from     the start until the file
  68.            transfer    is just    about to begin.    This includes all
  69.            pre-transfer  commands  and  negotiations that are
  70.            specific    to the particular protocol(s) involved.
  71.  
  72.        CCUURRLLIINNFFOO__SSTTAARRTTTTRRAANNSSFFEERR__TTIIMMEE
  73.            Pass a pointer to a double to receive the time, in
  74.            seconds,     it  took  from    the start until    the first
  75.            byte is just about to be    transfered. This includes
  76.            CURLINFO_PRETRANSFER_TIME  and  also  the time the
  77.            server needs to calculate the result.
  78.  
  79.        CCUURRLLIINNFFOO__RREEDDIIRREECCTT__TTIIMMEE
  80.            Pass a pointer to a double to  receive  the  total
  81.            time,  in  seconds,  it    took  for all redirection
  82.            steps include name  lookup,  connect,  pretransfer
  83.            and transfer before final transaction was started.
  84.            CURLINFO_REDIRECT_TIME contains the complete  exe
  85.            cution  time for    multiple redirections.    (Added in
  86.            7.9.7)
  87.  
  88.        CCUURRLLIINNFFOO__RREEDDIIRREECCTT__CCOOUUNNTT
  89.            Pass a pointer to a long    to receive the total num
  90.            ber  of    redirections that were actually    followed.
  91.            (Added in 7.9.7)
  92.  
  93.        CCUURRLLIINNFFOO__SSIIZZEE__UUPPLLOOAADD
  94.            Pass a pointer to a double to  receive  the  total
  95.            amount of bytes that were uploaded.
  96.  
  97.        CCUURRLLIINNFFOO__SSIIZZEE__DDOOWWNNLLOOAADD
  98.            Pass  a    pointer     to a double to    receive    the total
  99.            amount of bytes that were downloaded.
  100.  
  101.        CCUURRLLIINNFFOO__SSPPEEEEDD__DDOOWWNNLLOOAADD
  102.            Pass a pointer to a double to receive the  average
  103.            download    speed that curl    measured for the complete
  104.            download.
  105.  
  106.        CCUURRLLIINNFFOO__SSPPEEEEDD__UUPPLLOOAADD
  107.            Pass a pointer to a double to receive the  average
  108.            upload  speed  that curl    measured for the complete
  109.            upload.
  110.  
  111.        CCUURRLLIINNFFOO__HHEEAADDEERR__SSIIZZEE
  112.            Pass a pointer to a long    to receive the total size
  113.            of all the headers received.
  114.  
  115.        CCUURRLLIINNFFOO__RREEQQUUEESSTT__SSIIZZEE
  116.            Pass a pointer to a long    to receive the total size
  117.            of the issued requests. This is so  far    only  for
  118.            HTTP requests. Note that    this may be more than one
  119.            request if FOLLOWLOCATION is true.
  120.  
  121.        CCUURRLLIINNFFOO__SSSSLL__VVEERRIIFFYYRREESSUULLTT
  122.            Pass a pointer to a long    to receive the result  of
  123.            the  certification verification that was    requested
  124.            (using  the   CURLOPT_SSL_VERIFYPEER   option   to
  125.            curl_easy_setopt). (Added in 7.4.2)
  126.  
  127.        CCUURRLLIINNFFOO__CCOONNTTEENNTT__LLEENNGGTTHH__DDOOWWNNLLOOAADD
  128.            Pass a pointer to a double to receive the content-
  129.            length of the download. This  is     the  value  read
  130.            from the    Content-Length:    field.    (Added in 7.6.1)
  131.  
  132.        CCUURRLLIINNFFOO__CCOONNTTEENNTT__LLEENNGGTTHH__UUPPLLOOAADD
  133.            Pass  a    pointer    to a double to receive the speci
  134.            fied size of the    upload.     (Added    in 7.6.1)
  135.  
  136.        CCUURRLLIINNFFOO__CCOONNTTEENNTT__TTYYPPEE
  137.            Pass a pointer to a 'char *' to receive    the  con
  138.            tent-type  of  the  downloaded object. This is the
  139.            value read from the Content-Type:  field.  If  you
  140.            get  NULL,  it means that the server didn't send    a
  141.            valid Content-Type header  or  that  the     protocol
  142.            used doesn't support this.  (Added in 7.9.4)
  143.  
  144.  
  145.  
  146. RREETTUURRNN VVAALLUUEE
  147.        If  the    operation  was    successful, CURLE_OK is    returned.
  148.        Otherwise an appropriate    error code will    be returned.
  149.  
  150. SSEEEE AALLSSOO
  151.        ccuurrll__eeaassyy__sseettoopptt(3)
  152.  
  153. BBUUGGSS
  154.        Surely there are    some, you tell me!
  155.  
  156.  
  157.  
  158. libcurl    7.9.7           25 Apr 2002        curl_easy_init(3)
  159.